multinet (version 3.0.3)

Network management: updates: Manipulation of multilayer networks

Description

Functions to add or remove components of a multilayer network.

The functions add_vertices_ml and delete_vertices_ml add/remove the input actors to/from the input layers, but do not add/remove the actors from the multilayer network.

A layer can also be added from an igraph object, where the vertex attribute name represents the actor name, using the add_igraph_layer_ml function. add_vertices_ml and delete_vertices_ml add/remove the input actors to/from the input layers, but do not add/remove the actors from the multilayer network.

The functions add_nodes_ml and delete_nodes_ml are deprecated in the current version of the library. Vertex/vertices are now preferentially used over node/nodes.

Usage

add_layers_ml(mlnetwork, layers, directed=FALSE)
add_actors_ml(mlnetwork, actors)
add_vertices_ml(mlnetwork, vertices)
add_edges_ml(mlnetwork, edges)
add_igraph_layer_ml(mlnetwork, g, name)
delete_layers_ml(mlnetwork, layers)
delete_actors_ml(mlnetwork, actors)
delete_vertices_ml(mlnetwork, vertices)
delete_edges_ml(mlnetwork, edges)

Arguments

mlnetwork

A multilayer network.

layers

An array of names of layers.

actors

An array of names of actors.

g

An igraph object with simple edges and a vertex attribute called name storing the actor name corresponding to the vertex.

name

Name of the new layer.

directed

Determines if the layer(s) is (are) directed or undirected. If multiple layers are specified, directed should be either a single value or an array with as many values as the number of layers.

vertices

A dataframe of vertices to be updated. The first column specifies actor names, the second layer names.

edges

A dataframe containing the vertices to be connected. The four columns must contain, in this order: actor1 name, layer1 name, actor2 name, layer2 name. The directionality of the edge (directed/undirected) is pre-defined depending on the layer(s).

See Also

Network management: properties, Network management: edge directionality

Examples

# NOT RUN {
net <- ml_empty()
# Adding some layers
add_layers_ml(net,"l1")
add_layers_ml(net,c("l2","l3"),c(TRUE,FALSE))
layers_ml(net)
# Adding actors A1, A2, A3
add_actors_ml(net,"A1")
add_actors_ml(net,c("A2","A3"))
# Verifying that the actors have been added correctly
num_actors_ml(net)
actors_ml(net)
# Adding some vertices (actor A3 is not present in layer l3: no corresponding vertex there)
vertices <- data.frame(
    c("A1","A2","A3","A1","A2","A3"),
    c("l1","l1","l1","l2","l2","l2"))
add_vertices_ml(net,vertices)
vertices <- data.frame(
    c("A1","A2"),
    c("l3","l3"))
add_vertices_ml(net,vertices)
vertices_ml(net)
# We create a data frame specifying two edges:
# A2,l2 -- A3,l1
# A2,l2 -- A3,l2
edges <- data.frame(
    c("A2","A2"),
    c("l2","l2"),
    c("A3","A3"),
    c("l1","l2"))
add_edges_ml(net,edges)
edges_ml(net)

# The following deletes layer 1, ans also deletes
# all vertices from "l1" and the edge with an end-point in "l1"
delete_layers_ml(net,"l1")
# The following also deletes the vertices associated to
# "A1" in layers "l2" and "l3"
delete_actors_ml(net,"A1")
# deleting vertex A2,l3 and edge A2,l2 -- A3,l2
delete_vertices_ml(net,data.frame("A2","l3"))
edges <- data.frame("A2","l2","A3","l2")
delete_edges_ml(net,edges)
net
# }